<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html><head>
<meta content="text/html; charset=ISO-8859-1" http-equiv="content-type"><title>Step by step tutorial for Webukkit</title>

</head>
<body>
Step by step tutorial for installing Webukkit v1.0 - 2011/02/25<br>
<br>
Introduction<br>
This
is a step by step tutorial for installing Webukkit. This document cover
the installation under Linux and Windows system (Sorry for Mac users, i
don't have a Mac). This document DO NOT cover the installation of XAMPP
/ APACHE &nbsp;/ MYSQL / PHP. Please check appropriate website for
this.<br>
<br>
Pre-requisites<br>
It's better to install Webukkit on your minecraft server.<br>
<br>
For Windows :<br>
You must have a HTTP server and a MySQL server.<br>
For the tutorial i'll use the XAMPP 1.7.1 software, you can download it
here :<br>
http://www.apachefriends.org/en/xampp.html<br>
Follow this tutorial for installing XAMPP :<br>
http://www.apachefriends.org/en/xampp-windows.html#641<br>
<br>
For Linux :<br>
You must have a HTTP server and a MySQL server.<br>
There will available in many distro. <br>
You must know the root password of the MySQL server. <br>
<br>
Step 1 - Getting Webukkit<br>
You can download the latest version of Webukkit here :<br>
http://code.google.com/p/bukkit-webadmin/downloads/list<br>
<br>
Step 2 - Unzipping<br>
Unzip the archive of Webukkit into the root html folder.<br>
For XAMPP under Window, it must be <br>
\xampp\htdocs<br>
<br>
For Linux, most of the root html folder will be :<br>
/var/www/html<br>
if not, please check your distro FAQ or manual.<br>
<br>
Unzip the zip file inside this directory.<br>
You will have a
structure like this :<br>
<img style="width: 682px; height: 411px;" alt="" src="http://www.phpgameengine.eu/images/bukkit/tutorial/2011-02-25_163052.png"><br>
or in Linux :<br>
<img style="width: 810px; height: 397px;" alt="" src="http://www.phpgameengine.eu/images/bukkit/tutorial/2011-02-25_163216.png"><br>
<br>
Step 3 - Configuration for Linux<br>
If you don't use Linux, go to step 4.<br>
You must set write access for directories.<br>
With a root shell go into /app/ and set write access for tmp and
config, like this :<br>
<img style="width: 810px; height: 397px;" alt="" src="http://www.phpgameengine.eu/images/bukkit/tutorial/2011-02-25_163427.png"><br>
If you don't have a shell, do this operation with your FTP software.<br>
<br>
Step 4 - Connect to the installer interface:<br>
You must connect now to the HTTP interface of your server :
http//yourserver/index.php/installer<br>
You will have this screen :<br>
<img style="width: 897px; height: 531px;" alt="" src="http://www.phpgameengine.eu/images/bukkit/tutorial/2011-02-25_164128.png"><br>
Fields explanation :<br>
Server
host : is the server where your database is. 99,99% of the time is
"localhost". Unless your database is not on the same server than your
http server.<br>
Root username : indicate the account which have
privileges to create database. Or if you have already a database,
indicate an account which privilege on it.<br>
Root password : if the account have a password, indicate it.<br>
Database
: If you want to create a database, leave this field blank, the default
name for the database created is "bukkitadmin". If you want to use an
existing database, type the name.<br>
Prefix : If you want to use prefix on the webukkit tables, indicate it.
If not, you can leave blank.<br>
<br>
Once fields completed, we will check if the parameters is good : click
on the "Check config" button :<br>
<img style="width: 899px; height: 618px;" alt="" src="http://www.phpgameengine.eu/images/bukkit/tutorial/2011-02-25_165336.png"><br>
If you have an error at this step, it's because the parameters you
entered are not good.<br>
<br>
If the&nbsp; checking is success. We can now create the config
file. Click on the "Create config file" button :<br>
<img style="width: 890px; height: 216px;" alt="" src="http://www.phpgameengine.eu/images/bukkit/tutorial/2011-02-25_165516.png"><br>
If you have an error at this step, it's certainly because you don't
have rights
on directory (check the step 3)<br>
Now
we can create the database (if you have type a database name in the
form, this button will be disabled), click on "Create database" button.
If you have an error here, it's because your account have not
privileges to create a database.<br>
Next, click on "Create tables", and then "Create data". <br>
Done, the server is ready !<br>
<img style="width: 898px; height: 329px;" alt="" src="http://www.phpgameengine.eu/images/bukkit/tutorial/2011-02-25_170127.png"><br>
<br>
You can now to http://yourserver/index.php and start using Webukkit.<br>
<br>
Step 5 - Logging to Webukkit<br>
Log into the interface with the default admin account : admin/admin<br>
<img style="width: 920px; height: 443px;" alt="" src="http://www.phpgameengine.eu/images/bukkit/tutorial/2011-02-25_170610.png"><br>
<br>
Next, click on the "Admin" button.<br>
<img style="width: 262px; height: 80px;" alt="" src="http://www.phpgameengine.eu/images/bukkit/tutorial/2011-02-25_170711.png"><br>
Next click on the "Config" button.<br>
<img style="width: 913px; height: 258px;" alt="" src="http://www.phpgameengine.eu/images/bukkit/tutorial/2011-02-25_170819.png"><br>
<br>
It's time to configure Webukkit for taking in charge Minecraft.<br>
<br>
Step 6 - Configure Webukkit<br>
"Config" tab :<br>
<img style="width: 897px; height: 465px;" alt="" src="http://www.phpgameengine.eu/images/bukkit/tutorial/2011-02-25_171719.png"><br>
Dynmap :<br>
if you have dynmap installed, you can indicate here the complete access
to it. You must type the ip and port, like this :<br>
http://192.168.1.103:8123/<br>
Don't
indicate localhost, because Webukkit will display a iframe with the url
of dynmap. If you indicate localhost, your browser will check your
local workstation.<br>
Unless your browser is on the same server than dynmap.<br>
Minecraft path :<br>
Give
the complete path to minecraft on the server. In this case, Webukkit
MUST&nbsp;be installed on the same server than Minecraft server. <br>
Example, <br>
For my Linux box, the path is /usr/minecraft<br>
For my Windows server, the path is c:\temp\minecraft<br>
Use TcpBukkit : if you have TCPBukkit installed, you can check this box.<br>
TCPBukkit let you manage players inventory, and let you send pm to
players.<br>
use RemoteToolkit : if you have Remote Toolkit you can check this box.<br>
Remote Toolkit let you manage your server : you can stop/start/restart
your minecraft server.<br>
Use Permissions plugin : if you have Permissions plugin and you want to
add automatically new users to Permissions plugin, you can check this
box.<br>
Permissions plugin is a hierarchical system for permissions of
compatible plugins.<br>
If you check one of the box, you can set the options :<br>
<img style="width: 899px; height: 658px;" alt="" src="http://www.phpgameengine.eu/images/bukkit/tutorial/2011-02-25_183816.png"><br>
TCP Bukkit :<br>
TCP Bukkit server : put the IP adress of the minecraft server with TCP
Bukkit plugin installed. You can put localhost if the Webukkit is
installed on the same server than Minecraft.<br>
TCP Bukkit port : put the port of the minecraft server with TCP Bukkit
plugin installed, by default is 6790, even if you have not changed the
port type it.<br>
TCP Bukkit password : put the password of TCP Bukkit, by default is
password, even if you have not changed the password, type it.<br>
<br>
Remote Toolkit :<br>
Remote Toolkit server : put the IP adress of the minecraft server with
Remote Toolkit plugin installed. You can put localhost if the Webukkit
is installed on the same server than Minecraft.<br>
Remote Toolkit port : put the port of the minecraft server with Remote
Toolkit plugin installed, by default is 25561, so you must type 25561
even if you have not changed the port.<br>
Remote Toolkit user : put the user of Remote Toolkit, by default is
user, even if you have not changed the user, type it.<br>
Remote Toolkit password : put the password of Remote Toolkit, by
default is pass, even if you have not changed the password, type it.<br>
<br>
Permissions plugin :<br>
If you want users to be automatically included in the plugin
PERMISSIONS, check the box and enter the group of the plugin where
users will be registered.<br>
The list is calculated automatically from the configuration file of the
plugin.<br>
If you have an error when you check the box : uncheck the box, click on
save and reload the config menu. you'll have the the list.<br>
<br>
Don't forget to click on "Save" when you'll be done.<br>
<br>
"Admin password" tab :<br>
<img style="width: 576px; height: 251px;" alt="" src="http://www.phpgameengine.eu/images/bukkit/tutorial/2011-02-25_185705.png"><br>
Change the default admin password.<br>
<br>
"Plugins" tab :<br>
By default, i've included some configurations plugins :<br>
<img style="width: 898px; height: 495px;" alt="" src="http://www.phpgameengine.eu/images/bukkit/tutorial/2011-02-25_185807.png"><br>
This is the list where all plugins are declared. If you click on "+"
you can add your own plugin:<br>
<img style="width: 452px; height: 363px;" alt="" src="http://www.phpgameengine.eu/images/bukkit/tutorial/2011-02-25_190606.png"><br>
Indicate the name of the plugin (it's case
sensitive, it must be the same than the plugin file under /plugins
directory, but without the .jar extension)<br>
Url is useless, it's just for info.<br>
Indicate the config&nbsp;file you want to edit (it's relative to
the minecraft directory).<br>
Example : you have a plugin named "Yaouh.jar" in the /minecraft/plugins
directory, this plugin use a config file named
"yaouh.config.properties" in the "/plugins/yaouh/" directory. If you
want to add this plugin, you must type this :<br>
Name : Yaouh<br>
URL : what you want<br>
config :&nbsp;/plugins/yaouh/yaouh.config.properties<br>
Then click on the "Save" button.<br>
<br>
After that you will see your plugin "yaouh" under the plugins menu.<br>
"Users" tab :<br>
Here you can manage the registered users. For the moment you can only
delete users.<br>
<img style="width: 898px; height: 284px;" alt="" src="http://www.phpgameengine.eu/images/bukkit/tutorial/2011-02-25_191015.png"><br>
<br>
Go to the step 2 of the tutorial : how to use Webukkit !
</body></html>